Package com.orange.webcom.sdk.datasync

Exposes the API of the Webcom Realtime Database service (or "datasync" in short).

Types

Link copied to clipboard
class DatasyncManager : Closeable

Handles a set of subscriptions to data nodes and authentication events.

Link copied to clipboard
class DatasyncNode(manager: DatasyncManager, val path: String) : Subscriber

Represents a data node within the tree-like data of a Webcom application.

Link copied to clipboard
class DatasyncService : WebcomAbstractService, Closeable

The WebcomAbstractService that makes it possible to interact in real time with the data of a Webcom application.

Link copied to clipboard
enum DatasyncTime : Enum<DatasyncTime>

Represents a write-policy into the Webcom database.

Link copied to clipboard
open class DatasyncValue : TreeLikeData

Represents a tree-like value stored by the Webcom datasync service within its real-time database.

Link copied to clipboard
typealias PresenceState = ISO8601Date

Type used to publish the user's presence, which the DatasyncService.startPublishingMyPresence and DatasyncService.isPresent methods rely on.

This type should only be used to convert DatasyncValue values using the DatasyncValue.converted or DatasyncValue.convertTo methods.

Link copied to clipboard
sealed class TransactionOperation

Represents a write operation to perform on a data node within an atomic transaction.

Link copied to clipboard
data class TransactionResult(val value: DatasyncValue, val hasCompleted: Boolean)

Represents the result of a transaction run by the DatasyncNode.runTransaction method.

Properties

Link copied to clipboard
val WebcomApplication.datasyncService: DatasyncService

Convenient shortcut to service(DatasyncService::class to retrieve the unique instance of DatasyncService associated with this WebcomApplication.